Documentation & Setup Improvements #59

PSchmiedmayer · 2024-01-10T10:18:12Z

Documentation & Setup Improvements

⚙️ Release Notes

Adds a DocC-based Documentation to host articles and inline-documentation about different parts of the template application.
Adds a setup script to automatically install all the necessary tools and software elements to use the Spezi Template Application.
Adds DocC articles to address part of Documentation Improvements #55:
- Setup your development environment
- Change the template application to fit your project needs
- Modify the application and point to relevant Spezi Modules

📝 Code of Conduct & Contributing Guidelines

By submitting creating this pull request, you agree to follow our Code of Conduct and Contributing Guidelines:

I agree to follow the Code of Conduct and Contributing Guidelines.

codecov · 2024-01-10T10:39:09Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (82bda2a) 80.54% compared to head (e9eb7a7) 80.65%.

❗ Current head e9eb7a7 differs from pull request most recent head e0842c8. Consider uploading reports for the commit e0842c8 to get more accurate results

Additional details and impacted files

@@            Coverage Diff             @@
##             main      #59      +/-   ##
==========================================
+ Coverage   80.54%   80.65%   +0.12%     
==========================================
  Files          31       33       +2     
  Lines         976      961      -15     
==========================================
- Hits          786      775      -11     
+ Misses        190      186       -4

Files	Coverage Δ
TemplateApplication/Account/AccountButton.swift	`100.00% <ø> (ø)`
...mplateApplication/Account/AccountSetupHeader.swift	`100.00% <ø> (ø)`
TemplateApplication/Account/AccountSheet.swift	`95.66% <ø> (ø)`
TemplateApplication/Contacts/Contacts.swift	`91.84% <ø> (ø)`
...eApplication/Contributions/ContributionsList.swift	`100.00% <ø> (ø)`
...pplication/Contributions/Package+LicenseType.swift	`83.73% <ø> (ø)`
...emplateApplication/Contributions/PackageCell.swift	`86.49% <ø> (ø)`
...plateApplication/Contributions/PackageHelper.swift	`63.64% <ø> (ø)`
TemplateApplication/Helper/Binding+Negate.swift	`100.00% <ø> (ø)`
TemplateApplication/Helper/Bundle+Image.swift	`0.00% <ø> (ø)`
... and 23 more

Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 82bda2a...e0842c8. Read the comment docs.

.github/workflows/documentation-deployment.yml

PSchmiedmayer added 3 commits January 9, 2024 23:22

Add Setup Script

b7f8fa8

Add First Set of Docs

71eff2c

Update Documentation Setup

6349f58

PSchmiedmayer added the documentation Improvements or additions to documentation label Jan 10, 2024

PSchmiedmayer self-assigned this Jan 10, 2024

PSchmiedmayer added 2 commits January 10, 2024 02:22

Update Setup

68657de

Update gitignore

9abae4d

PSchmiedmayer had a problem deploying to github-pages January 10, 2024 10:23 — with GitHub Actions Error

Update Setup

604ca43

PSchmiedmayer had a problem deploying to github-pages January 10, 2024 10:24 — with GitHub Actions Failure

Update GitHub Action

4e63d9b

PSchmiedmayer had a problem deploying to github-pages January 10, 2024 10:31 — with GitHub Actions Failure

skipPackagePluginValidation

e9eb7a7

PSchmiedmayer had a problem deploying to github-pages January 10, 2024 10:45 — with GitHub Actions Failure

PSchmiedmayer had a problem deploying to github-pages January 10, 2024 16:12 — with GitHub Actions Failure

PSchmiedmayer had a problem deploying to github-pages January 10, 2024 18:34 — with GitHub Actions Failure

Update Setup

ae9931f

PSchmiedmayer had a problem deploying to github-pages January 11, 2024 03:56 — with GitHub Actions Error

Update Setup

906d560

PSchmiedmayer temporarily deployed to github-pages January 11, 2024 04:02 — with GitHub Actions Inactive

Update Setup

5e64e19

PSchmiedmayer had a problem deploying to github-pages January 11, 2024 04:30 — with GitHub Actions Error

Improve Setup

3165be1

PSchmiedmayer had a problem deploying to github-pages January 11, 2024 04:38 — with GitHub Actions Error

Update Setup

a8a41c0

PSchmiedmayer temporarily deployed to github-pages January 11, 2024 04:48 — with GitHub Actions Inactive

Update Documentation and Images

4c2dd2b

PSchmiedmayer temporarily deployed to github-pages January 11, 2024 08:48 — with GitHub Actions Inactive

Update Setup

fb2105b

PSchmiedmayer temporarily deployed to github-pages January 11, 2024 09:06 — with GitHub Actions Inactive

Update Setup

ff89a29

PSchmiedmayer had a problem deploying to github-pages January 11, 2024 09:21 — with GitHub Actions Error

Merge branch 'main' into feature/setup

dc25c89

PSchmiedmayer had a problem deploying to github-pages January 11, 2024 09:23 — with GitHub Actions Error

PSchmiedmayer commented Jan 11, 2024

View reviewed changes

.github/workflows/documentation-deployment.yml Outdated Show resolved Hide resolved

Try Self Hosted

e788d2c

PSchmiedmayer had a problem deploying to github-pages January 11, 2024 09:31 — with GitHub Actions Error

Update Setupg

a7e0e91

PSchmiedmayer had a problem deploying to github-pages January 11, 2024 09:40 — with GitHub Actions Error

PSchmiedmayer added 2 commits January 11, 2024 01:41

Update GitHub Action

e0842c8

Fix Link

074c072

PSchmiedmayer merged commit 81b34a2 into main Jan 11, 2024
3 of 4 checks passed

PSchmiedmayer deleted the feature/setup branch January 11, 2024 09:43

PSchmiedmayer mentioned this pull request Jan 11, 2024

Documentation Improvements #55

Open

6 tasks

Supereg mentioned this pull request Jan 11, 2024

Create a script for renaming the project #47

Closed

1 task

vishnuravi mentioned this pull request Mar 24, 2024

Create Firebase setup article #67

Closed

1 task

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Documentation & Setup Improvements #59

Documentation & Setup Improvements #59

PSchmiedmayer commented Jan 10, 2024 •

edited

Loading

codecov bot commented Jan 10, 2024 •

edited

Loading

Documentation & Setup Improvements #59

Documentation & Setup Improvements #59

Conversation

PSchmiedmayer commented Jan 10, 2024 • edited Loading

Documentation & Setup Improvements

⚙️ Release Notes

📝 Code of Conduct & Contributing Guidelines

codecov bot commented Jan 10, 2024 • edited Loading

Codecov Report

PSchmiedmayer commented Jan 10, 2024 •

edited

Loading

codecov bot commented Jan 10, 2024 •

edited

Loading